home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / asmutil / coreaids.zip / COREAIDS.DOC < prev    next >
Text File  |  1987-06-26  |  47KB  |  975 lines
  1.       CoreAids Macro Assembler Subroutine Library Utilities
  2.                     Copyright 1987, CoreTechs
  3.  
  4. You are free to use, copy and distribute CoreAids providing that:
  5.         NO FEE IS CHARGED FOR USE, COPYING OR DISTRIBUTION.
  6.         IT IS NOT MODIFIED IN ANY WAY.
  7.  
  8. These subroutines are provided AS IS without any warranty,
  9. expressed or implied, including but not limited to fitness for a
  10. particular purpose.
  11.  
  12. Please send comments, suggestions and contributions to:
  13.  
  14.                             CoreTechs
  15.                           P.O. Box 6207
  16.                      Silver Spring, MD 20906
  17.  
  18.            SECTION I. ROUTINES LISTED ALPHABETICALLY
  19.  
  20. ALOC_CHG.ASM         6/25/87       902
  21.         DESC:   Modifies Allocated memory block size                 V1.00
  22.         IN:     *{BLOCK} segment address of memory block to be modified
  23.                 *{PARA} new requested block size in paragraphs {ie multiples
  24.                  of 16 bytes}
  25.         SAMPLE: Callm   ALOC_CHG,<BLOCK,PARA>,
  26.  
  27. ATRB_WRT.ASM         6/25/87      2268
  28.         DESC:   Writes character attributes to the screen            V1.00
  29.         IN:     *{PAGE} page number (0-3) 4 available pages in 80 column mode
  30.                 *{ROWCOL} row(0-24),col(0-79) (ie 0345 indicating fourth row,
  31.                  46th column)
  32.                 *{ATRB} attribute (see technical reference manual for
  33.                  information on color graphics adapter)
  34.                 *{NUM_CHARS} # of chars to be affected
  35.         SAMPLE: Callm   ATRB_WRT,<PAGE,ROWCOL,ATRB,NUM_CHARS>,
  36.  
  37. CHAR_GET.ASM         6/25/87       771
  38.         DESC:   gets a character from the keyboard                   V1.00
  39.         IN:     *{REQ_TYPE} (0:get character,1:see if character
  40.                  is there,2:get shift status)
  41.         OUT:    *{CHAR} character ( high byte is shift status,
  42.                  low byte is char.)
  43.         SAMPLE: Callm   CHAR_GET,<REQ_TYPE>,<CHAR>
  44.  
  45. CHG_DIR.ASM          6/25/87       821
  46.         DESC:   Changes to a new directory using the path provided   V1.00
  47.         IN:     *{SEG_VAL} segment  and
  48.                 *{OFFSET} offset of path string
  49.         SAMPLE: Callm   CHG_DIR,<SEG_VAL,OFFSET>,
  50.  
  51. CHG_MOD.ASM          6/25/87      1211
  52.         DESC:   Changes the mode of a file                           V1.00
  53.                 (ie archived, hidden, system)
  54.         IN:     *{SEG_VAL} segment and
  55.                 *{OFFSET} offset of filename
  56.                 *{FUNC_CODE} function code(1:set mode,0:get mode)
  57.                 *{FILE_MODE} mode of file (1:read only,2:hidden file,
  58.                  4:system file,8:volume label,10H:sub-directory,
  59.                  20H:archived file
  60.         OUT:    *{CMODE} mode of file after completions of call
  61.         SAMPLE: Callm   CHG_MOD,<SEG_VAL,OFFSET,FUNC_CODE,FILE_MODE>,<CMODE>
  62.  
  63. CLEAR.ASM            6/25/87       524
  64.         DESC:   Clears the screen                                    V1.00
  65.         SAMPLE: Callm   CLEAR,,
  66.  
  67. CLOSE.ASM            6/25/87       693
  68.         DESC:   Closes a file handle                                 V1.00
  69.         IN:     *{INHNDL} handle of file to be closed
  70.         SAMPLE: Callm   CLOSE,<INHNDL>,
  71.  
  72. COPY.ASM             6/25/87      2768
  73.         DESC:   Copies existing file to new or existing file         V1.00
  74.                 using complete path names
  75.         IN:     *{OUT_SEG_VAL} segment and
  76.                 *{OUT_OFFSET} offset of new filename
  77.                 *{IN_SEG_VAL} segment and
  78.                 *{IN_OFFSET} offset of old filename
  79.         SAMPLE: Callm   COPY,<OUT_SEG_VAL,OUT_OFFSET,IN_SEG_VAL,IN_OFFSET>,
  80.  
  81. CREATE.ASM           6/25/87      1009
  82.         DESC:   Creates a new data file                              V1.00
  83.         IN:     *{SEG_VAL} segment and
  84.                 *{OFFSET} offset of filename to be created as ASCIIZ string
  85.                 *{ATRB} attribute or mode of file as listed in CHG_MOD
  86.                  command
  87.         OUT:    *{OUTHNDL} handle of file created
  88.         SAMPLE: Callm   CREATE,<SEG_VAL,OFFSET,ATRB>,<OUTHNDL>
  89.  
  90. CURS_GET.ASM         6/25/87       938
  91.         DESC:   Gets Cursor Position                                 V1.00
  92.         IN:     *{PAGE_NUM} page number (0-7) in 40 character mode
  93.                  or (0-3) in 80 character mode (i.e. 0003) is page 4
  94.         OUT:    *{ROWCOL} row (0-24),col (0-79)  (i.e. 0104)
  95.                  1st row, 5th column
  96.                 *{CURS_MODE} cursor mode (see manual for description)
  97.         SAMPLE: Callm   CURS_GET,<PAGE_NUM>,<ROWCOL,CURS_MODE>
  98.  
  99. CURS_SET.ASM         6/25/87       883
  100.         DESC:   Sets Cursor Position                                 V1.01
  101.         IN:     *{ROWCOL} row and column to postion cursor
  102.                  row (0-24),col (0-79)  (i.e. 0104)
  103.                  1st row, 5th column
  104.                 *{PAGE_NUM} page number (0-7) in 40 character mode and (0-3)
  105.                  in 80 character mode (i.e. 0003) is page 4
  106.         SAMPLE: Callm   CURS_SET,<ROWCOL,PAGE_NUM>,
  107.  
  108. DATE_GET.ASM         6/25/87      1482
  109.         DESC:   Gets the system date                                 V1.00
  110.         OUT:    *{SEG_VAL} segment and
  111.                 *{OFFSET} offset of system date in format MM/DD/YY
  112.         SAMPLE: Callm   DATE_GET,<SEG_VAL,OFFSET>,
  113.  
  114. DELETE.ASM           6/25/87       822
  115.         DESC:   Deletes a file                                       V1.00
  116.         IN:     *{SEG_VAL} segment
  117.                 *{OFFSET} offset of filename to be deleted
  118.         SAMPLE: Callm   DELETE,<SEG_VAL,OFFSET>,
  119.  
  120. ERRORMSG.ASM         6/25/87      5589
  121.         DESC:   Prints DOS error messages 1-18 and additional user   V1.01
  122.                  supplied messages from 19 up. If the value of ERR_NUM is
  123.                  0 control returns to the calling program with no effect.
  124.                  If ERR_NUM is greater than the value of the maximum error
  125.                  message then the message "No Error for This Value" is
  126.                  displayed and control returns to DOS. If an error code is
  127.                  displayed then control also returns to DOS. The memory
  128.                  address where the error occured is displayed on exit.
  129.         IN:     *{ERR_NUM} error number where the possible legal values are:
  130.                  1......Invalid Function Number
  131.                  2......File Not Found
  132.                  3......Path Not Found
  133.                  4......Too Many Open Files (no handles left)
  134.                  5......Access Denied
  135.                  6......Invalid Handle
  136.                  7......Memory Control Blocks Destroyed
  137.                  8......Insufficient Memory
  138.                  9......Invalid Memory Block Address
  139.                 10......Invalid Environment
  140.                 11......Invalid Format
  141.                 12......Invalid Access Code
  142.                 13......Invalid Data
  143.                 14......This Error Does Not Exist
  144.                 15......Invalid Drive Was Specified
  145.                 16......Attempted To Remove The Current Directory
  146.                 17......Not Same Device
  147.                 18......No More Files
  148.                 19......No Room For File(s) On Target Disk
  149.                 20......No Filename(s) Specified
  150.                 21......No Volume Label On Disk
  151.                 22......Wrong Number of Parameters
  152.                 >22.....No Error for This Value
  153.         SAMPLE: Callm   ERRORMSG,<ERR_NUM>,
  154.  
  155. EXECUTE.ASM          6/25/87      2336
  156.         DESC:   Loads and Executes another program                   V1.00
  157.         IN:     *{SEG_VAL} segment and
  158.                 *{OFFSET} offset of filename to run including extension
  159.                 *{PAR_HI} high word and
  160.                 *{PAR_LO} low word of pointer to command line
  161.                  to be passed to new program. Command line should be in the
  162.                  form N,' ',PARAM,0DH where N is the length of PARAM+1, and is
  163.                  followed by a space. PARAM is the command line and 0DH is
  164.                  a carriage return ending the line.
  165.                 *{MEMBLK} segment value of last memory control block 
  166.                  segment is typically the val